Kanzi 3.9.10
kanzi::PropertyTargetInterpolator Class Reference

Use a Property Target Interpolator when you want to dynamically set the target value of a property and want to interpolate the current value to the target value over time. More...

#include <kanzi/ui/node_component/animation/property_target_interpolator.hpp>

Inheritance diagram for kanzi::PropertyTargetInterpolator:
[legend]

Classes

class  CompletedMessageArguments
 Message arguments for Completed message. More...
 

Public Member Functions

float getAcceleration () const
 Gets the value of the AccelerationProperty.
 
float getDrag () const
 Gets the value of the DragProperty.
 
PropertyField getInterpolatedPropertyField () const
 Gets the value of the InterpolatedPropertyFieldProperty.
 
string getInterpolatedPropertyType () const
 Gets the value of the InterpolatedPropertyTypeProperty.
 
void setAcceleration (float value)
 Sets the value of the AccelerationProperty.
 
void setDrag (float value)
 Sets the value of the DragProperty.
 
void setInterpolatedPropertyField (PropertyField value)
 Sets the value of the InterpolatedPropertyFieldProperty.
 
void setInterpolatedPropertyType (string_view value)
 Sets the value of the InterpolatedPropertyTypeProperty.
 
- Public Member Functions inherited from kanzi::NodeComponent
void attach (NodeWeakPtr node)
 Attaches node component to node.
 
void detach ()
 Detaches node component from the node it was attached to.
 
string getName () const
 Gets the name of node component.
 
NodeSharedPtr getNode () const
 Returns the node the node component is attached to or null pointer if node component is not attached to a node.
 
State getState () const
 Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.
 
bool isAttached () const
 Indicates whether node component is attached to a node.
 
bool isAttaching () const
 Indicates whether node component is in the process of attaching to a node.
 
bool isAttachingOrAttached () const
 Indicates whether node component is in the process of attaching to a node or already attached.
 
bool isDetached () const
 Indicates whether node component is detached from any node.
 
bool isDetaching () const
 Indicates whether node component currently detaching from the node.
 
bool isDetachingOrDetached () const
 Indicates whether node component is in the process of detaching from the node or already detached.
 
void setName (string_view name)
 Sets the name of node component.
 
 ~NodeComponent () override
 Destructor.
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object.
 
void applyObjectStyles ()
 Apply all styles for an object node.
 
DomaingetDomain () const
 Returns the domain the object belongs to.
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object.
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain.
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object.
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object.
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object.
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object.
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles.
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it.
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers.
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container.
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object.
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object.
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers.
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type.
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers.
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property.
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property.
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value.
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications.
 
 PropertyObject ()
 
void removeKzbProperties ()
 Remove all KZB properties.
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set.
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property.
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type.
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static PropertyTargetInterpolatorSharedPtr create (Domain *domain, string_view name)
 Creates a Property Target Interpolator.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 

Static Public Attributes

static PropertyType< floatAccelerationProperty
 Sets the speed at which the interpolated property reaches its new value.
 
static MessageType< CompletedMessageArgumentsCompletedMessage
 The node to which the Property Target Interpolator is attached sends the Completed message when the Property Target Interpolator completes the interpolation.
 
static PropertyType< floatDragProperty
 Controls the maximum interpolation speed.
 
static PropertyType< KzuPropertyBinaryTargetAttributeInterpolatedPropertyFieldProperty
 Sets the property field of the property type that you want to interpolate with a Property Target Interpolator.
 
static PropertyType< string > InterpolatedPropertyTypeProperty
 Sets the property type that you want interpolate with a Property Target Interpolator in the node to which you attach the Property Target Interpolator.
 
- Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string > NameProperty
 Name property specifies the name of node component.
 

Protected Member Functions

void attachOverride () override
 NodeComponent::attachOverride() implementation.
 
void detachOverride () override
 NodeComponent::detachOverride() implementation.
 
void onInterpolationCompleted (TimelinePlayback &playback)
 Sends message about completion of interpolation.
 
 PropertyTargetInterpolator (Domain *domain, string_view name)
 Constructor.
 
- Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method)
 Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name.
 
template<typename TMessageType >
Node::MessageSubscriptionToken addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function)
 Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name.
 
void dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
 Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component.
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Adds the name of the node component to the message arguments and dispatches the message to the node of the node component.
 
 NodeComponent (Domain *domain, string_view name)
 Constructor.
 
void removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
 Removes message handler added via addNodeComponentMessageHandler function.
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value.
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source.
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage.
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor.
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor.
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage.
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage.
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source.
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers.
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers.
 

Additional Inherited Members

- Public Types inherited from kanzi::NodeComponent
using NodeComponentMessageArguments
 Legacy name for NodeComponentTargetMessageArguments.
 
enum  State { StateDetached , StateDetaching , StateAttaching , StateAttached }
 State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container.
 
- Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType >
static void nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments)
 Handler function for node component messages.
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object.
 

Detailed Description

Use a Property Target Interpolator when you want to dynamically set the target value of a property and want to interpolate the current value to the target value over time.

With a Property Target Interpolator you can automatically animate the change of a property value to achieve a smooth transition. Without a Property Target Interpolator Kanzi immediately applies a new value to a property. For example, when you use the Object::setProperty() function, Kanzi immediately applies a new value.

Use the InterpolatedPropertyTypeProperty to set the property type that you want the Property Target Interpolator to interpolate in the node to which you attach the Property Target Interpolator.

Property Target Interpolator emulates the behavior of a spring-damper system which never overshoots. Use these properties to control the behavior of the interpolation:

  • AccelerationProperty sets the force with which the spring moves the object. The larger the value of the Acceleration property is, the faster the property reaches its new value.
  • DragProperty sets the damping coefficient. The larger the value of the Drag property is, the lower is the maximum interpolation speed.

The Property Target Interpolator applies the InterpolatedPropertyTypeProperty, AccelerationProperty, and DragProperty properties only when you attach the Property Target Interpolator to a node. You cannot change the target property or interpolation behavior of the Property Target Interpolator by setting the values of these properties after the Property Target Interpolator is already attached to a node.

See also
AnimationPlayer, PropertyDrivenAnimationPlayer

Examples

To create a Property Target Interpolator and set its target property and interpolation settings:

// Create property target interpolator.
PropertyTargetInterpolatorSharedPtr interpolator = PropertyTargetInterpolator::create(domain, "player");
// Set type name of property which should be interpolated on the node where interpolator will be attached.
interpolator->setInterpolatedPropertyType(Node2D::OpacityProperty.getName());
// Adjust interpolation settings.
interpolator->setAcceleration(2.0f);
interpolator->setDrag(1.0f);

To attach a Property Target Interpolator to a node:

Constructor & Destructor Documentation

◆ PropertyTargetInterpolator()

kanzi::PropertyTargetInterpolator::PropertyTargetInterpolator ( Domain * domain,
string_view name )
explicitprotected

Constructor.

Parameters
domainDomain.
nameName of the Property Target Interpolator.

Member Function Documentation

◆ getInterpolatedPropertyType()

string kanzi::PropertyTargetInterpolator::getInterpolatedPropertyType ( ) const

◆ setInterpolatedPropertyType()

void kanzi::PropertyTargetInterpolator::setInterpolatedPropertyType ( string_view value)

◆ getInterpolatedPropertyField()

PropertyField kanzi::PropertyTargetInterpolator::getInterpolatedPropertyField ( ) const

◆ setInterpolatedPropertyField()

void kanzi::PropertyTargetInterpolator::setInterpolatedPropertyField ( PropertyField value)

◆ getAcceleration()

float kanzi::PropertyTargetInterpolator::getAcceleration ( ) const

Gets the value of the AccelerationProperty.

See also
setAcceleration()

◆ setAcceleration()

void kanzi::PropertyTargetInterpolator::setAcceleration ( float value)

Sets the value of the AccelerationProperty.

See also
getAcceleration()

◆ getDrag()

float kanzi::PropertyTargetInterpolator::getDrag ( ) const

Gets the value of the DragProperty.

See also
setDrag()

◆ setDrag()

void kanzi::PropertyTargetInterpolator::setDrag ( float value)

Sets the value of the DragProperty.

See also
getDrag()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::PropertyTargetInterpolator::makeEditorInfo ( )
static

◆ create()

static PropertyTargetInterpolatorSharedPtr kanzi::PropertyTargetInterpolator::create ( Domain * domain,
string_view name )
static

Creates a Property Target Interpolator.

Parameters
domainDomain.
nameName of the Property Target Interpolator.
Returns
The Property Target Interpolator.

◆ attachOverride()

void kanzi::PropertyTargetInterpolator::attachOverride ( )
overrideprotectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

◆ detachOverride()

void kanzi::PropertyTargetInterpolator::detachOverride ( )
overrideprotectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

◆ onInterpolationCompleted()

void kanzi::PropertyTargetInterpolator::onInterpolationCompleted ( TimelinePlayback & playback)
protected

Sends message about completion of interpolation.

The Property Target Interpolator calls this function when its interpolation completes.

Parameters
playbackThe Playback of the interpolation which completed.

Member Data Documentation

◆ CompletedMessage

MessageType<CompletedMessageArguments> kanzi::PropertyTargetInterpolator::CompletedMessage
static

The node to which the Property Target Interpolator is attached sends the Completed message when the Property Target Interpolator completes the interpolation.

◆ InterpolatedPropertyTypeProperty

PropertyType<string> kanzi::PropertyTargetInterpolator::InterpolatedPropertyTypeProperty
static

Sets the property type that you want interpolate with a Property Target Interpolator in the node to which you attach the Property Target Interpolator.

The default value of this property is "".

See also
setInterpolatedPropertyType(), getInterpolatedPropertyType(), InterpolatedPropertyFieldProperty

◆ InterpolatedPropertyFieldProperty

PropertyType<KzuPropertyBinaryTargetAttribute> kanzi::PropertyTargetInterpolator::InterpolatedPropertyFieldProperty
static

Sets the property field of the property type that you want to interpolate with a Property Target Interpolator.

The default value of this property is "".

See also
setInterpolatedPropertyField(), getInterpolatedPropertyField(), InterpolatedPropertyTypeProperty

◆ AccelerationProperty

PropertyType<float> kanzi::PropertyTargetInterpolator::AccelerationProperty
static

Sets the speed at which the interpolated property reaches its new value.

Property Target Interpolator emulates the behavior of a spring-damper system which never overshoots. The Acceleration property sets the force with which the spring moves the object. The larger the value of the Acceleration property is, the faster the property reaches its new value. The default value is 1.0f.

See also
setAcceleration(), getAcceleration(), DragProperty

◆ DragProperty

PropertyType<float> kanzi::PropertyTargetInterpolator::DragProperty
static

Controls the maximum interpolation speed.

Property Target Interpolator emulates the behavior of a spring-damper system which never overshoots. The Drag property sets the damping coefficient. The larger the value of the Drag property is, the lower is the maximum interpolation speed. The default value is 0.0f.

See also
setDrag(), getDrag(), AccelerationProperty

The documentation for this class was generated from the following file: